Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nodejs port #173

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

nodejs port #173

wants to merge 1 commit into from

Conversation

missinglink
Copy link
Member

@missinglink missinglink commented Feb 13, 2020

This library is the first experience most developers have with Pelias 🚀
When I originally wrote it, I wasn't expecting it to be so popular and to become the default method of running Pelias.
Also, a year on we've learned a lot more about how people use it and the issues that can arise.

This PR ports the bash scripts to nodejs for increased readability, editability and testability.
Some benefits of having it in node:

  • everyone can edit it and contribute without worrying about what's supported in bash3
  • much more portable (even to Windows?)
  • no dependencies on shell commands and specific installations for Mac tools
  • one line install via npm i -g
  • ability to write tests
  • ability to extend the core with a module system if required
  • ability to perform more complex environmental checks for things like env/users/groups/paths

What's been ported:

  • pelias compose
  • pelias download (still requires some control-flow code to allow parallel downloads)
  • pelias import
  • pelias elastic
  • pelias prepare
  • pelias system
  • pelias test

Other considerations:

  • easy upgrade from the bash version
  • no-op refactor so all the old command work the same
  • update any documentation/readme

I'm looking for support from the community to get this over the finish line!

@missinglink missinglink added the help wanted Extra attention is needed label Feb 13, 2020
@missinglink missinglink changed the title nodejs: initial commit of nodejs port nodejs port Feb 13, 2020
@missinglink missinglink mentioned this pull request Feb 16, 2020
@missinglink
Copy link
Member Author

This is a really cool guide for creating good CLI apps https://clig.dev

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant